Skip to content

feat: rename lightning embedding command to ui-embedding#995

Open
aman06it wants to merge 3 commits into
salesforcecli:mainfrom
aman06it:feat/rename-ui-embedding
Open

feat: rename lightning embedding command to ui-embedding#995
aman06it wants to merge 3 commits into
salesforcecli:mainfrom
aman06it:feat/rename-ui-embedding

Conversation

@aman06it

@aman06it aman06it commented Jul 21, 2026

Copy link
Copy Markdown
Contributor

What

Renames the sf template generate lightning embedding command to sf template generate ui-embedding.

  • Command class moved: lightning/embedding.tsui-embedding/index.ts
  • Messages lightningEmbedding.mduiEmbedding.md
  • NUT test moved to ui-embedding/index.nut.ts
  • package.json oclif topic updated to ui-embedding
  • command-snapshot.json regenerated
  • Removed "widget" terminology (widget URL → embedding URL)
  • Standardized angle-bracket usage in help text (<lightning-ui-embedding>)

Dependency

⚠️ Depends on forcedotcom/salesforcedx-templates PR (UI Embedding rename). The renamed symbols (UIEmbeddingOptions, TemplateType.UIEmbedding, isAllowedUIEmbeddingSrcUrl, UI_EMBEDDING_SANDBOX_TOKENS) must be published to @salesforce/templates first, or CI here will fail to resolve them. Merge/release after that PR.

Note

Command is state = 'beta' and hidden = true — not in README/docs, no back-compat obligation.

Rename the `template generate lightning embedding` command to
`template generate ui-embedding`. Update command class, messages,
tests, package.json topic, and command snapshot.

Remove "widget" terminology and standardize angle-bracket usage in
help text (<lightning-ui-embedding>).

@W-23468815@ @W-23301022@ @W-23301024@
Comment thread package.json
"ui-bundle": {
"description": "Generate a UI bundle."
},
"ui-embedding": {

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is this a net-new entry and not a renaming of an existing one?

@aman06it aman06it Jul 23, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jfeingold35 Good question — it's net-new rather than a rename because the old command wasn't a top-level topic. It was template generate lightning embedding, a leaf command nested under the existing lightning topic (src/commands/template/generate/lightning/embedding.ts), so there was no embedding topic entry to rename — the lightning entry describes that whole command group (app/component/event/etc.), not the embedding command specifically.

This PR promotes it to a top-level command, template generate ui-embedding (now at .../ui-embedding/index.ts). A top-level command needs its own topic description, exactly like the neighboring ui-bundle entry — which is why this shows up as an addition. The lightning topic entry is untouched since its other subcommands still live there.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants